Taking an Offsite Copy

A sample SessionToken will be used throughout this use case.
The sample SessionToken will be: e65aedeb-a0e7-440c-8309-1cc0bcd920db

Base URLs are required depending on the version of VM Backup being used. <base_url> for each version is:

V8.x: http://localhost:35113/api

V9.0.x: http://localhost:36015/api

V9.1.x: http://localhost:36013/api/rest

To start an offsite copy, the AltaroVirtualMachineRef is required. This way, the API can be instructed which configured VM to perform the offsite copy on. The following POST method starts an offsite copy operation on the VM. The response will contain a Success value, which states whether VM Backup managed to start the backup operation. When this is false, it means that something went wrong while the API was processing the request, but before sending it over to the VM Backup Agent. When this occurs, it is generally due to an incorrect parameter, such as sending an AltaroVirtualMachineRef which does not exist. When the Success value is set to true, it does not mean that the operation is successful; it simply means that the operation could be processed by the API and could be successfully sent over to the VM Backup Agent.

<base_url>/instructions/take-offsitecopy/e65aedeb-a0e7-440c-8309-1cc0bcd920db/ba2e9cdc-0d85-48e6-8db7-a45c5a40819e

 

To monitor the activity and results of the operation, refer to the Take Backup operation above.

 

Note: A full list of available API commands can be found here